---
title: 'qryn'
description: 'Configuring the qryn backend (Self-Hosted)'
sidebarTitle: 'qryn'
icon: 'signal-stream'
---

### Getting Started

<img src="https://d15jtxgb40qetw.cloudfront.net/qryn.svg" alt="qryn-oss" className="not-prose h-20" />

{/*
    Add custom content here (under this comment)...

    e.g.

    **Creating Account**<br />
    Go to the **[🔗 website](https://odigos.io) > Account** and click **Sign Up**

    **Obtaining Access Token**<br />
    Go to **⚙️ > Access Tokens** and click **Create New**

    !! Do not remove this comment, this acts as a key indicator in `docs/sync-dest-doc.py` !!
    !! START CUSTOM EDIT !!
*/}

{/*
    !! Do not remove this comment, this acts as a key indicator in `docs/sync-dest-doc.py` !!
    !! END CUSTOM EDIT !!
*/}

### Configuring Destination Fields

<Accordion title="Supported Signals:">
  ✅ Traces
  ✅ Metrics
  ✅ Logs
</Accordion>

- **QRYN_OSS_URL** `string` : API Url. The API Endpoint for for your qryn instance
  - This field is required
  - Example: `http://qryn.local:3100`
- **QRYN_OSS_PASSWORD** `string` : Basic auth password. The HTTP Basic Auth password for your qryn instance
  - This field is optional
- **QRYN_OSS_USERNAME** `string` : Basic auth username. The HTTP Basic Auth username for your qryn instance
  - This field is optional
- **QRYN_OSS_RESOURCE_TO_TELEMETRY_CONVERSION** `boolean` : Convert container attributes to labels.
  - This field is optional and defaults to `True`
- **QRYN_OSS_ADD_EXPORTER_NAME** `boolean` : Add exporter name to labels.
  - This field is optional and defaults to `True`

### Adding Destination to Odigos

There are two primary methods for configuring destinations in Odigos:

##### **Using the UI**

<Steps>
  <Step>
    Use the [Odigos CLI](https://docs.odigos.io/cli/odigos_ui) to access the UI
    ```bash
    odigos ui
    ```
  </Step>
  <Step>
    Click on `Add Destination`, select `qryn` and follow the on-screen instructions
  </Step>
</Steps>

##### **Using Kubernetes manifests**

<Steps>
  <Step>
    Save the YAML below to a file (e.g. `qryn-oss.yaml`)
    ```yaml
    apiVersion: odigos.io/v1alpha1
    kind: Destination
    metadata:
      name: qryn-oss-example
      namespace: odigos-system
    spec:
      data:
        QRYN_OSS_URL: <API Url>
        # Note: The commented fields below are optional.
        # QRYN_OSS_USERNAME: <Basic auth username>
        # QRYN_OSS_RESOURCE_TO_TELEMETRY_CONVERSION: <Convert container attributes to labels (default: True)>
        # QRYN_OSS_ADD_EXPORTER_NAME: <Add exporter name to labels (default: True)>
      destinationName: qryn-oss
      # Uncomment the 'secretRef' below if you are using the optional Secret.
      # secretRef:
      #   name: qryn-oss-secret
      signals:
      - TRACES
      - METRICS
      - LOGS
      type: qryn-oss

    ---

    # The following Secret is optional. Uncomment the entire block if you need to use it.
    # apiVersion: v1
    # data:
    #   QRYN_OSS_PASSWORD: <Base64 Basic auth password>
    # kind: Secret
    # metadata:
    #   name: qryn-oss-secret
    #   namespace: odigos-system
    # type: Opaque
    ```
  </Step>
  <Step>
    Apply the YAML using `kubectl`
    ```bash
    kubectl apply -f qryn-oss.yaml
    ```
  </Step>
</Steps>